﻿//-----------------------------------------------------------------------------
// <copyright file="PlayerPromptableAttribute" company="WheelMUD Development Team">
//   Copyright (c) WheelMUD Development Team.  See LICENSE.txt.  This file is 
//   subject to the Microsoft Public License.  All other rights reserved.
// </copyright>
// <summary>
//   A primary action alias attribute.
// </summary>
//-----------------------------------------------------------------------------

namespace WheelMUD.Core.Attributes
{
    using System;

    /// <summary>
    /// The attribute that goes above the primary alias for an action.
    /// </summary>
    [AttributeUsage(AttributeTargets.Method, AllowMultiple = false)]
    public class PlayerPromptableAttribute : Attribute
    {
        /// <summary>
        /// Initializes a new instance of the PlayerPromptableAttribute class.
        /// </summary>
        /// <param name="token">Token to replaced in the string, for example %PlayerCurrentHealth%</param>
        /// <param name="description">String description to be provided to the player, for example "Displays your current health,"</param>
        public PlayerPromptableAttribute(string token, string description)
        {
            this.Token = token;
            this.Description = description;
        }

        public string Token { get; private set; }
        public string Description { get; private set; }
    }
}